home *** CD-ROM | disk | FTP | other *** search
/ Netware Super Library / Netware Super Library.iso / inet_tcp / gnipx / gnipread.txt < prev    next >
Text File  |  1995-03-07  |  7KB  |  192 lines
  1. GNIP - (G)NIP is a (N)ew (I)nterface for (P)ING
  2. ===============================================
  3.  
  4.  
  5. Purpose
  6. -------
  7.  
  8. The GNIP program was created to provide two new features not currently
  9. available with the LANtastic 6.0 'NET PING' command:
  10.  
  11. 1.  GNIP displays the serial number of each node found on the network.
  12. This allows a network administrator to quickly determine which machines on
  13. the network are using which serial numbers.
  14.  
  15. 2.  To return errorlevel codes which can be used in DOS batch files for
  16. determining presence of a node and whether the node is a LANtastic server.
  17.  
  18.  
  19. How PING Works
  20. --------------
  21.  
  22. The LANtastic 6.0 PING interface uses network broadcast datagrams to identify
  23. nodes by their machine names.  The REDIR program listens for PING query
  24. datagrams that match its name and respond with a datagram containing
  25. information about the node, including version, serial number, and whether
  26. SERVER is currently running.  Once a node has been identified, a "be quiet"
  27. datagram is sent to it.  Queries and "be quiet" datagrams are sent until the
  28. ping response buffer fills or no further responses are received.
  29.  
  30.  
  31. Caveats
  32. -------
  33.  
  34. 1.  The PING interface is only available in LANtastic 6.0 or higher.  Earlier
  35. versions will not run GNIP and will not respond to PING query datagrams.
  36.  
  37. 2.  Datagrams are by definition a "non-reliable" transport mechanism.  They
  38. can be lost due to collisions on the network or if the receiver is busy
  39. doing something else, like processing another datagram.  Although the PING 
  40. interface usually finds all the matching nodes, network performance and
  41. traffic can affect results.
  42.  
  43. 3.  Only one node on the network can issue PING broadcasts at any one time.
  44. A PING reservation and release broadcast is used to arbitrate among multiple
  45. nodes.  GNIP will automatically try twice before returning a "Network Busy"
  46. error.
  47.  
  48. 4.  A LANtastic node does not reply to its own PINGs.  When enumerating
  49. serial numbers, you can type REDIR /DESCRIBE to see the serial number of
  50. the node you are using.
  51.  
  52. 5.  Wildcard PINGs will cause a burst of datagrams on the network,
  53. determined by how many nodes match the wildcard, and how readily they
  54. recognize a "be quiet" datagram.  A non-wildcard, single-node ping will not
  55. cause any significant network traffic.
  56.  
  57.  
  58.  
  59. Syntax
  60. ------
  61.  
  62. The GNIP command line looks like:
  63.  
  64.   GNIP <Machine> {A=Adapter} {N=Number} {Raw} {Silent}
  65.  
  66.  
  67. Where:
  68.  
  69.   <Machine> is the machine name of the node or nodes on the network that
  70.   you wish to identify.  You can PING for nodes beginning with a common
  71.   string by appending the '*' wildcard character to the string or identify
  72.   all nodes on the network by specifying <Machine> with a single '*'.  This
  73.   is the only required command line argument.
  74.  
  75.   'Adapter' is the logical adapter number on which to perform the PING.  If
  76.   no adapter is specified, all adapters will be searched.
  77.  
  78.   'Number' is the number of responses to collect during the PING.  A 
  79.   node may reply several times before seeing a "be quiet" message, so it is
  80.   best to specify N to be at least twice the number of nodes you expect to
  81.   discover.  The default number is 1, which is sufficient for a PING of a
  82.   single node.  The maximum N is 910.  Specifying a larger value will return
  83.   a "Not enough memory" error.
  84.  
  85.   The 'Raw' command line switch turns off filtering of multiple responses.
  86.   This switch can be used to identify network nodes that are not receiving
  87.   "be quiet" messages due to network delays or hardware problems.
  88.  
  89.   The 'Silent' command line switch turns off all displays other than
  90.   command line or memory errors.  This switch can be used to test for a
  91.   single node from within a batch file and testing ERRORLEVEL for the results
  92.   of the PING.  See below for a sample batch file.
  93.  
  94.  
  95. Display
  96. -------
  97.  
  98. The ping response data is displayed in five columns.  A sample display looks
  99. like this:
  100.  
  101. Machine              Adapter  Version  Server  Serial Number
  102. TOWER1                  0       6.0      √       ABC0001001
  103.  
  104.  
  105. Examples
  106. --------
  107.  
  108.   GNIP TOWER1
  109.  
  110.   Looks for a machine named 'TOWER1' on any adapter.
  111.  
  112.  
  113.   GNIP TOWER* A=0 N=10
  114.  
  115.   Looks for any machines with names starting with 'TOWER' on adapter 0.  A
  116.   total of ten responses will be accepted before filtering multiple responses.
  117.  
  118.   GNIP * N=50
  119.  
  120.   Identifies all machines on all adapters.  A total of 50 responses will be
  121.   accepted before filtering out multiple responses.
  122.  
  123.   GNIP * N=200 Raw
  124.  
  125.   Identifies all machines on all adapters.  A total of 200 responses will be
  126.   accepted.  Multiple responses will be displayed.
  127.  
  128.  
  129. ERRORLEVEL Values
  130. -----------------
  131.  
  132. GNIP will return one of six error codes depending on the results of a 
  133. non-wildcard PING:
  134.  
  135.   0   - Indicates that the PING found the specified node and it is running
  136.         SERVER.
  137.  
  138.   1   - Is the DOS error code for Invalid function.  This usually means that
  139.         a LANtastic 6.x REDIR is not present on the machine trying to run
  140.         GNIP.
  141.  
  142.   8   - Is the DOS error code for Out of memory.  N was greater than 910 or
  143.         there was insufficient DOS memory.
  144.  
  145.   54  - Is the DOS error code for Network Busy.  This means that another node
  146.         on the network is currently using PING.
  147.  
  148.   148 - Is the error code returned if there were no responders to the PING.
  149.  
  150.   149 - Is the error code returned if the specified node was found but it
  151.         is only running REDIR.  It is not running SERVER.
  152.  
  153.  
  154. GNIP can return error codes 1, 8, 54 or 148 above for wildcard PINGs.  A
  155. return code of 0 only means that a wildcard PING found at least one node.
  156.  
  157. Sample Batch File
  158. -----------------
  159.  
  160. Here is a sample batch file that tests the error code returned by GNIP.
  161. Note the use of the 'Silent' command line switch to turn off any display
  162. and that errorlevels must be tested in descending order.
  163.  
  164. @echo off
  165. gnip %1 silent
  166. if errorlevel 149 goto foundw
  167. if errorlevel 148 goto noresp
  168. if errorlevel 54 goto busy
  169. if errorlevel 1 goto invalid
  170. echo %1 is a server
  171. goto end
  172. :invalid
  173. echo REDIR not present
  174. goto end
  175. :busy
  176. echo Network busy
  177. goto end
  178. :foundw
  179. echo %1 is a workstation
  180. goto end
  181. :noresp
  182. echo %1 not found
  183. :end
  184. ------------------------------------------------------------------
  185. ARTISOFT, Inc. makes no warranties as to the completeness or accuracy of this 
  186. document. LANtastic is a trademark of ARTISOFT, Inc. Brand names, company 
  187. names, and product names are trademarks or registered trademarks of their 
  188. respective companies.
  189.  
  190.  
  191.  
  192.